Configuring Import: Totalflow Laptop Commands

Use the Import File: Totalflow Laptop command to import measurement data contained in Totalflow laptop files into your FMS system. This file import command triggers the service to import files of the defined format into FMS, according to the specified parameters.

Note: Files that are successfully imported are moved into a "Processed" sub-directory, and files that either completely or partially fail are moved into a "Failed" sub-directory. In cases of duplicate import files of the same name, the system automatically appends a number to the file name of subsequent versions to distinguish them. The file you select for use must have the original file name however, so edit the file names if necessary to use the selected file version with the expected name.

See Installing CygNet Measurement for more information about installation and registration of support files.

See FMS Commands and Import: Totalflow Laptop for more information about this command.

See Scheduling FMS Command Tasks in the MSS for more information about scheduling commands.

See FMS ActiveX Controls and CxHmiFms for more information about using commands via FMS ActiveX controls on CygNet Studio or CygNet Vision screens.

See CxFms for more information about scripting commands.

Command Definition Properties

The following command definition properties apply to Totalflow Laptop File Import commands.

Property Description

Command type

For system commands, this property will be read-only and will display the selected command type.

See FMS Commands for more information about command types.

Priority

Select a processing queue Priority for the command from the drop-down menu.

Options from least to greatest priority are as follows.

  • Low level
  • Medium level
  • High level
  • User initiated transaction
  • Admin initiated transaction

Default value is Low level processing queue priority.

Logging

Select a Logging level for the command results from the drop-down menu.

Options are as follows.

  • Low — displays errors
  • Medium — displays errors and warnings
  • High — displays errors, warnings, and status

Default value is Low level logging when scheduling a command in the MSS.

Default value is High level logging when creating or running an ad-hoc command in FMS Explorer.

Command Parameters

The following command parameters apply to Import: Totalflow Laptop File commands, when creating or editing commands in FMS.

Note: This command imports configuration, event, alarm, and gas measurement history data. Gas quality history data is not currently supported.

Parameter Value

Import file directory

Enter the directory location from which to import the file.

Type in the value or click ... to access the Browse for Folder dialog box, and browse to the directory location.

Note: The directory specified is relative to the computer hosting the FMS.

This parameter is required.

Import file mask

If specified, only files meeting the file mask will be considered for import.

Type the file mask name.

Default file mask value is "*" (multiple character wildcard).

This parameter is optional.

Add devices to group

If specified, all devices with imported data will be added to the group.

Type the name of the group to which the imported devices will be added.

Note: Nodes added to this group are added for the entire span of the Node or group (whichever is less).

Example

In the case of a GQ import, you could execute a Send Gas Quality command to send GQ data from all imported files to the devices.

This parameter is optional.

Clear existing group entries

If specified, options are Yes or No.

If set to Yes, and a value has been specified for Add devices to group, any existing entries will be removed from the specified group before executing the command.

If set to No, the existing group entries will be retained when executing the command.

Note: Nodes cleared from this group are cleared for the entire span of the Node or group.

This parameter is optional.

Comments

If specified, the comments will be part of the audit record for the file import.

Type comments regarding the import.

This parameter is optional.

Processed files retention (days)

If specified, the files that have been processed will be deleted after the specified number of days. If not specified, processed files will never be deleted.

Type the number of days.

This parameter is optional.

Unit set

Select a unit set in which to view the data.

Options appear in the drop-down menu, which is populated by the unit sets defined in the service.

See Configuring Unit Set Definitions for more information.

This parameter is required.

Back to top